|
If you can't view the Datasheet, Please click here to try to view without PDF Reader . |
|
Datasheet File OCR Text: |
december 2012 doc id 022791 rev 2 1/37 UM1518 user manual st7580 power line modem demonstration kit graphical user interface (gui) introduction the ?st7580 gui? is a software tool that allows one or more st power line modem (plm) demonstration boards to be interfaced with a personal computer (pc). only plm demonstration boards equipped with the st7580 device are supported. when using the st7580 gui the user has complete control of the st7580 device, having access to all its registers and functions described in [ 2 ]. the typical application environment (shown in figure 1 ) consists of an st7580 gui running on a pc and communicating through a usb connection with a plm demonstration kit equipped with the st7580 product, such as the evalkitst7580-1 (consisting of an evalst7580-1 modem board and an evlaltair900-m1 power supply board). figure 1. st7580 typical application environment per s onal computer ( p c) s t75 8 0gui u s b c ab le main s pl u g e valkit s t75 8 0-1 s t75 8 0 plm ev a l ua tion bo a rd (eval s t75 8 0-1) altair4-900 power su pply ev a l ua tion bo a rd (evlaltair900-m1) am16520v1 www.st.com
contents UM1518 2/37 doc id 022791 rev 2 contents 1 document conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 1.1 list of abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2 connection procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 3 gui installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 3.1 software license agreement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 3.2 system requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3.3 installing the software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 4 getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 4.1 introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 4.2 opening the com . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 5 services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 5.1 basic modem configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 5.2 power line communication: transmission and reception . . . . . . . . . . . . . . 16 5.2.1 power line transmission command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 5.2.2 power line confirm command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 5.2.3 power line reception command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 5.3 mib operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 5.4 other st7580 commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 5.4.1 ping commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 5.4.2 reset commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 5.4.3 status message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 5.5 host interface errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 5.6 ping session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 5.6.1 ping protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 5.6.2 ping master session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 5.6.3 ping slave session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 5.6.4 starting and stopping a ping session . . . . . . . . . . . . . . . . . . . . . . . . . . 34 6 references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 UM1518 contents doc id 022791 rev 2 3/37 7 revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 list of figures UM1518 4/37 doc id 022791 rev 2 list of figures figure 1. st7580 typical application environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 figure 2. hardware update wizard screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 figure 3. completing the found new hardware update wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 figure 4. st7580 gui installation wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 figure 5. st7580 gui destination folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 figure 6. gui setup start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 figure 7. gui setup finish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 figure 8. st7580 gui . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 figure 9. modem connection procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 figure 10. modem connection success . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 figure 11. modem configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 figure 12. power line transmission box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 figure 13. transmission notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 figure 14. power line confirm box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 figure 15. reception notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 figure 16. position of mib objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 figure 17. pingrequest and pingconfirm graphical tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 figure 18. resetrequest command: console view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 figure 19. resetindication command: console view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 figure 20. status message fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 figure 21. host interface error occurrence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 figure 22. ping session: master and slave tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 figure 23. payload subfields on dl frames of ping session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 figure 24. ping session: master flowchart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 figure 25. ping session: slave flowchart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 figure 26. ping master tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 figure 27. ping slave tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 UM1518 document conventions doc id 022791 rev 2 5/37 1 document conventions 1.1 list of abbreviations the following abbreviations are used: table 1. abbreviations abbreviation description pre preamble uw unique word mib management information base zc zero-crossing phy physical layer dl data link layer connection procedure UM1518 6/37 doc id 022791 rev 2 2 connection procedure in order to connect the evalkitst7580-1 to the pc, the user must follow the instructions below: 1. connect the board to the pc using a mini-usb cable. 2. plug a power cable into the board ac power plug. 3. plug the power cable into the power socket. as soon as the board is powered, the leds dl1, dl2 on evalst7580-1 switch on. usb/uart adapter driver installation the usb communication between the evalkitst7580-1 and the pc is managed through the onboard stm32 microcontroller, whose embedded default code acts as a usb to uart bridge. in order to allow the pc to properly recognize this microcontroller application, the installation of a proper software driver is necessary. assuming that the device drivers are not yet installed, the user must: 1. download the latest available virtual com port (vcp) drivers from the st website (at www.st.com) and unzip them to a location on the host pc. 2. launch the setup file ?vcp_v1.3.1_setup.exe? to install the virtual com port driver on the pc. 3. when the screen shown in figure 2 is displayed, click ?next? to proceed with the installation. figure 2. hardware update wizard screen UM1518 connection procedure doc id 022791 rev 2 7/37 4. the setup is completed and the screen shown in figure 3 is displayed. figure 3. completing the found new hardware update wizard 5. connect the evalkitst7580-1 to a spare usb port on the host pc: an ?stmicroelectronics virtual com port? is recognized by the pc device manager and the evalst7580-1 is installed and ready to use. gui installation UM1518 8/37 doc id 022791 rev 2 3 gui installation 3.1 software license agreement 1. important before loading this software you must read carefully and agree to the following terms and conditions which are automatically agreed to by loading this software or any portion thereof. if you do not agree to the terms of this agreement, do not install or use this software or any portion thereof. 2. license grant st grants you a non-exclusive, royalty-free, worldwide license to this software written for st products (?software?). you have the right to use, copy, modify and distribute the software with st products only. all st software is required to contain the st copyright notice which is not to be removed for any reason. you acknowledge that the software is not designed nor authorized for use in life supporting devices or systems. 3. ownership and copyright of software title to the software and all copies thereof remain with st. the software is copyrighted and protected by worldwide copyright laws and international treaty provisions. except as expressly provided herein, st does not grant any express or implied right to you under st patents, copyrights, trademarks, or trade secret information. 4. warranties and liabilities st makes no warranty express or implied including but not limited to, any warranty of (i) marketability or suitability for a particular purpose and/or (ii) requirements, for a particular purpose in relation to the software which is provided on an ?as is? basis. all warranties, conditions, or other terms implied by law are excluded to the fullest extent permitted by law. st is not liable for any claim made by you and/or against you by a third party, in relation to the software under this agreement. you take responsibility for the suitability, selection, use and management of the software and the results obtained there from as well as their combination and the combination of the elements thereof with other apparatus, equipment, products, programs and services. nothing contained in these terms is to be construed as a warranty or representation by st as to the validity or scope of any and all ipr in respect of which a license is herein granted or constitutes a warranty or representation that any manufacture, use or sale by you hereunder are free from infringement of any intellectual property rights (ipr) other than those under which and to the extent to which rights thereto are granted hereunder or constitute an agreement to bring or prosecute actions or suits against third parties for infringements or confer any right upon a party to use in advertising, publicity or other medium, any name trademark or trade name or any other contraction, abbreviation, or simulation thereto of the other party or confer by implication, estoppel or otherwise, upon you any license or other right under any and all ipr except the licenses and rights expressly granted hereunder to you. in no event is st liable for any damages whatsoever (including, without limitation, damages for loss of business revenue or profits, business interruption, loss of business information or other pecuniary loss) arising out of the use of or the inability to use the software as part of an st application. st does not assume any responsibility for any errors that may appear in the software nor any responsibility to support or update the UM1518 gui installation doc id 022791 rev 2 9/37 software. st retains the right to make changes to the software and its test specifications at any time, without notice. 5. entire agreement this agreement constitutes the entire agreement with st and supersedes any prior or contemporaneous oral or written agreements with respect to the subject matter of this agreement. 6. support under this agreement, st is under no obligation to assist in the use of the software, to provide you support of the software, or to provide maintenance, correction, modification, enhancement, or upgrades to the software. any action taken by st in this respect is unilaterally taken and subject only to st assessment - without any notice to you. any such action is considered as software and is automatically subject to this agreement. 7. termination of this license st is entitled to terminate this software license agreement at any time if you are in breach of any of the terms of this agreement. upon termination, you must immediately destroy the software. 8. export regulations you undertake to comply with all applicable laws, regulations, decrees and ordinances related to your use of the software. 9. applicable laws any dispute arising out of or in connection with this agreement which could not be amicably settled is to be finally settled under the rules of conciliation and arbitration of the international chamber of commerce by one or more arbitrators appointed in accordance with the said rules which the parties know and elect irrevocably. such arbitration is to take place in paris and be held in english. 3.2 system requirements a personal computer (pc) including: 1. operating system windows nt/2000/xp/7. 2. a hard disk with at least 15 mbytes of free space to install the gui. 3. one or more usb 1.1 ports. gui installation UM1518 10/37 doc id 022791 rev 2 3.3 installing the software follow the instructions below to install the st7580 gui software. 1. extract the contents of the archive in a new directory. 2. launch ?setup.exe? to start the install procedure. 3. press ?next? button ( figure 4 ): figure 4. st7580 gui installation wizard 4. choose an installation path (the default path is suggested) and press the ?next? button, ( figure 5 ). figure 5. st7580 gui destination folder UM1518 gui installation doc id 022791 rev 2 11/37 5. press the ?next? button to start the installation ( figure 6 ). figure 6. gui setup start 6. once the installation has completed, press the ?finish? button to conclude the process, ( figure 7 ). figure 7. gui setup finish getting started UM1518 12/37 doc id 022791 rev 2 4 getting started 4.1 introduction the st7580 gui gives the user complete control of the st7580 device, with full access to all the settings and functions described in [ 2 ]. the gui can be used to: establish a connection to the st7580 modem configure the st7580 and manage all its settings perform any transmission and reception of data over the power line open a ping session, where at least two modems (a master device and one or more slave devices) can communicate exchanging data. a single instance of the st7580 gui can handle only one evalst7580-1 board at a time. figure 8 shows the main window of the st7580 gui. the panel is divided into two sections: 1. console: box displaying all the messages exchanged with the node. the messages can be cleared or saved in a .txt file through options on the ?tools? menu bar; 2. node panel: used to control an st7580 node; it is divided into five tabs to easily change between the main service blocks of the node: ? the properties and services of the connection to the pc; ? the device's basic configuration, related to mib objects 00h (modem configuration) and 01h (phy configuration); ? the characteristics of the exchanged power line frames (for both transmitted and received frames); ? the access (writing, reading, erasing) to the mib objects. ? the settings to open a ping session (selecting master or slave role) and display the communication results. a point in the top part of this window always displays the composition of the status message returned by the modem and the occurrence of error during the last requested command: UM1518 getting started doc id 022791 rev 2 13/37 figure 8. st7580 gui 4.2 opening the com to establish communication with the evalst7580-1 demonstration board: 1. manually select the com port number associated to the board. 2. select the desired baud rate. note that the evalst7580-1 board has a factory default baud rate equal to 57600 bps. node p a nel 1 con s ole 2 am16527v1 getting started UM1518 14/37 doc id 022791 rev 2 figure 9. modem connection procedure if the connection is properly established, the light switches to green, and the console displays a positive notification and the status message returned by the modem: figure 10. modem connection success am11954v1 am11955v1 UM1518 services doc id 022791 rev 2 15/37 5 services 5.1 basic modem configuration at power-on, the default values stored in the mib objects are reported in [ 2 ]. from a power line communication point of view, it is already set to properly received frames (in compliance with values stored in mib objects modem configuration 00h and phy layer configuration 01h) and to accept transmission requests. if the user wants to change, at any moment, the two first mib values: 1. modem configuration 00h; 2. phy configuration 01h. all their parameters are selectable in the modem configuration tab: figure 11. modem configuration 2 1 modem con?guraon (mib object 00h) phy layer con?guraon (mib object 01h) am11956v1 services UM1518 16/37 doc id 022791 rev 2 the four buttons in the modem configuration tab, highlighted by the red squares, execute correspondingly: modem configuration write: it performs an ?mib write request? command automatically built with mib index 00h and data as selected in the objects above; modem configuration read: it performs an ?mib read request? command automatically built with mib index 00h; if the command is properly executed, the data contained in the expected ?mib read confirm? (sent by the st7580) is extracted and displayed in the objects above; phy configuration write: as the previous ?modem configuration write?, it performs an mib write request on the mib object 01h (phy layer configuration); phy configuration read: as the previous ?modem configuration read?, it performs an mib read request on the mib object 01h (phy layer configuration). 5.2 power line communication: transmission and reception in order to put into place a proper power line communication through the gui, it is enough to power on the evalst7580-1 and to open the usb port as explained in section 4.2 . the ?communication? tab contains all the parameters for st7580 commands related to power line communication: ?transmission? box: refers to three ?data request? commands and contains all their parameters and data to allow the user to choose the transmission settings; ?confirm? box: displays the parameters of the last ?data confirm? received from the st7580 device; ?reception? box: shows the parameters and the data of the last ?data indication? received. 5.2.1 power line transmission command as shown in figure 12 , the transmission box contains: 1. the ?tx layer? drop-down menu: through this parameter it is possible to choose which kind of data request command the gui addresses to the st7580. ? the phy_data selection determines a ?phy data request? command; ? the dl_data selection determines a ?dl data request? command; ? the ss_data selection determines a ?ss data request? command. 2. all transmission parameters to be filled in a data request command; note that: ? ?tx gain? value is accessible if ?gain selector? bit is equal to ?custom? value only; ? ?ss header length? value is accessible if selected ?tx layer? value is equal to ?ss_data? only. 3. the payload box where the data to be transmitted must be expressed in hexadecimal characters; 4. the length (in bytes) of the inserted payload data, automatically calculated and displayed. 5. the data request button that builds a data request command and transmits it to the st7580 connected device. UM1518 services doc id 022791 rev 2 17/37 figure 12. power line transmission box after pressing the data request command, the console displays it, followed by the message returned by the st7580, i.e. either a corresponding confirm or error message, as displayed in figure 13 . figure 13. transmission notifications 5.2.2 power line confirm command the confirm box, as depicted in figure 14 , shows the parameters of the last data confirm command. a green/red led reports the success of the previous data request. ! - v $ a t a 2 e q u e s t & |